Magnum One

home *** CD-ROM | disk | FTP | other *** search

/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / zdoor33.arc / ZDOOR32.DOC < prev next >

Wrap

Text File | 1989-03-12 | 84KB | 1,712 lines

ZDoor (C) Copyright 1987, 1988 by R. P. Byrne Version 3.2 February 12, 1989 ZDoor version 3.2 Documentation i ____________________________________________________________________________ Licensing Information......................................1 Program Overview...........................................2 Installation...............................................4 Configuration File(s) Setup............................4 Environment Variables.................................11 DSZPORT...........................................11 DSZLOG............................................11 Batch File Setup......................................11 Doors.Dat File Entry..................................12 Commands..................................................13 Sysop Commands........................................13 Display Toggle....................................13 Other Sysop Functions.............................13 Local Testing.....................................13 Main Menu Commands....................................14 A)bandon Conference...............................14 D)ownload a file..................................14 F)ile & Archive menu..............................15 G)oodbye (Hang up)................................15 H)elp.............................................16 I)nitial Welcome..................................16 L)ocate a file....................................16 MAIL..............................................16 MARK..............................................16 M)ode (graphics)..................................17 N)ew file scan....................................17 NEWS..............................................17 Q)uit ZDoor.......................................17 R)eset Last Msg Read Pointers.....................17 T)ransfer Protocol................................18 U)pload a file....................................18 V)iew Statistics..................................20 W)ho Uploaded/Downloaded..........................20 X)pert mode.......................................20 Z)ippy file scan..................................20 Files/Archive Submenu Commands........................21 D)ownload a file..................................21 L)ist file DIRectories............................22 <#> = view DIRectory #............................22 S)elect (new) Archive.............................22 V)erbose Archive listing..........................22 R)ead file in selected Archive....................22 E)xtract files to Temp Archive....................23 D)ownload selected Archive........................23 Advanced Facilities.......................................24 The MAIL command......................................24 Overview..........................................24 Selecting Message Base Areas to Scan..............24 Updating Default Message Scan Areas...............25 Resetting Last Message Pointers...................25 The MARK Facility.....................................26 ZDoor version 3.2 Documentation ii ____________________________________________________________________________ Overview..........................................26 MARK Options......................................26 MARKing Files.....................................26 UnMARKing Files...................................27 Downloading MARKed Files..........................27 Zippy Search String Enhancements......................28 Some Notes on Batch Uploads...............................30 Acknowledgements..........................................31 Feedback..................................................32 ZDoor Licensing Information Page 1 ____________________________________________________________________________ ZDoor is provided for private, personal use. You may distribute the ZDoor program so long as the following conditions are satisfied: The program is supplied in the original, unmodified archive file. No fee is charged for the distribution of ZDoor. ZDoor may not be distributed as part of any other application or service without the written consent of the author ZDoor is being distributed as a ShareWare product (sort of...). If you like the program then send the author a check for whatever you feel the program is worth. If you are running your bbs for profit, or as part of a business or government operation, then you are required to remit $25.00 to the author for each copy of PCBoard under which the ZDoor program will be run. Send checks to: Mr. Richard P. Byrne 5 Twin Elm Terrace Sparta, NJ 07871 * * * DISCLAIMER * * * Unfortunately, I cannot and do not claim or guarantee that the ZDoor program is good for anything! If YOU think it is, that's great, but it is up to you to decide. If you lose a million dollars because ZDoor messes up, I refuse to be held responsible...it is you that is out the million, not me! ZDoor Program Overview Page 2 ____________________________________________________________________________ ZDoor is a program for use with PCBoard version 14.0 that facilitates the use of Chuck Forsberg's DSZ program (Copyright 1987 by OMEN Technology Inc.) to provide PCBoard callers with the ability to upload and download files using the ZModem protocol. ====================================================================== NOTE: This release of ZDoor requires a version of DSZ dated NO EARLIER than 4/6/88! ====================================================================== By installing ZDoor on your system, you will be providing your callers with all of the advantages of ZModem including enhanced error correction/detection, enhanced throughput for callers using packet networks, the ability to resume an aborted transfer, batch mode transfers, and much, much more. For those of you operating your boards with modems that provide hardware error checking via the MNP protocol, ZDoor provides a YModem- G alternative to the ZModem protocol for even faster throughput. And for callers who simply refuse to become acquainted with the ZModem protocol, a true YModem protocol is available for batch transfers. For the caller's convenience, all of Pcboard's file-related functions are provided by ZDoor. These include N)ew file scans, L)ocate file, Z)ippy Directory scans, listing of DIR files, Conference J)oin and A)bandon, etc. The syntax for these functions duplicates that used within PCBoard itself. Several utility commands are also available to the caller such as O)perator Page, V)iew Statistics, M)ode, T)ransfer Protocol, and X)pert Mode Toggle. In addition to facilitating file transfers, ZDoor functions as an archive file processing door. Verbose listings of file contents are provided as well as the ability to display any text file contained in an archive (including those compressed with Phil Katz's "squash" algorithm). ZDoor also provides an archive extraction facility which allows callers to extract selected files from an archive. The extracted members are placed into a temporary archive file for downloading. Starting with version 3.1, ZDoor provides a MAIL download facility. Callers may select any combination of main board and conference message bases to be scanned for new mail. Any messages found will be extracted and archived for download. A command is also available to reset a caller's "last message read" pointers. ZDoor handles all of the various record keeping tasks required by a door of this type. The caller's daily time limit is closely monitored, his upload/download counts are kept up-to-date, time remaining is automatically adjusted for time spent uploading files, etc. ZDoor Program Overview Page 3 ____________________________________________________________________________ There are many other features of ZDoor that could be described here, however the best way to understand the program is to run it and watch... ZDoor Installation Page 4 ____________________________________________________________________________ Installation of ZDoor is a simple process. Simply create a subdirectory to hold the program and its support files (e.g. C:\ZDoor) and copy the contents of the ZDoor distribution archive into that subdirectory. ================================================================ Note: The ZDoor program itself consists of two files ... the main executable file (ZDoor.Exe) and an overlay file (ZDoor.Ovr). Both of these files must be present and must reside in the same subdirectory on your disk for the program to operate properly ================================================================ What little information the program cannot obtain from PCBoard's own setup files (pcboard.dat, cnames, etc.) is provided by the sysop in a configuration file. Once a configuration file has been built, a batch file is created to invoke the door program. This batch file serves to set various environment variables, invoke the door program, and return to PCBoard after the door program has been terminated. Finally, entries are made into PCBoard's Doors.Dat file(s) to inform the board software that a new door is available to callers. Configuration File(s) Setup =========================== The environment under which ZDoor will operate must be described in a configuration file. There is no magic associated with this file, so you can use your favorite editor (Edlin?) to put one together or make changes to the samples provided. There are only 2 rules to follow: * Put each entry on a line by itself * Precede any comment in the file with a semicolon ================================================================ NOTE: A separate configuration file needs to be created for each node of a multi-node system. ================================================================ Several sample configuration files are provided in the ZDoor archive. These should be used as templates for creating your own configuration files. ZDoor.Cfg - Sample config. for single node system ZDoor1.Cfg - Sample config. for 1st node of a two-node system ZDoor2.Cfg - Sample config. for 2nd node of a two-node system Pretty simple, eh? Ok, lets begin with a description of what is specified on each line in the file. ZDoor Installation Page 5 ____________________________________________________________________________ Line 1: Full Path and Filename for an Opening Message File This line specifies the "base" name of a text file that will be shown to the caller when the door is first opened. If the caller is NOT in graphics mode when the door is opened, ZDoor will look for a file with the name specified here. If the caller IS in graphics mode, ZDoor will append a 'G' to this filename and attempt to display it. Should this fail, ZDoor will fall back to displaying the file with the exact name specified here. If this too fails, no opening message will be displayed, and processing will continue normally. The contents of this file will NOT be paginated for the caller, so keep it short. Line 2: Full Path and Filename for a News File This line specifies the base name of a text file that will be displayed to the caller following the Opening Message File. As with the opening message file, a graphic version may be created. Append a 'G' to the name of the graphic version filename, and ZDoor will automatically display it if the caller is in Graphics mode. Similarly, if the graphic version cannot be found by ZDoor, the Non-Graphic news file is displayed. If neither is found, processing continues normally. Unlike the opening message file which is displayed each time a caller enters the door, the news file is only displayed to a caller if it has been modified since the last time that particular caller logged on to the bbs. The contents of this file will be paginated, so feel free to make it as long as you need it to be. Line 3: Full Path and Filename for a Logoff Message File This line specifies the name of a text file that will be displayed to the caller after the G)oodbye command is issued (before carrier is dropped). As with the Opening Message and News files, a graphic version may be created for callers in color graphics mode. The contents of this file will NOT be paginated, so keep it short. ZDoor Installation Page 6 ____________________________________________________________________________ Your existing Script0 file can be used, however the semicolons are not parsed out prior to display. It is suggested, therefore, that you copy Script0 to another name and then edit out the semicolons. Line 4: Full Path and Filename for a Help File This line specifies the base name of a text file that will be displayed to the caller if the H)elp command is selected from one of ZDoor's menus. As with the Opening Message and News files, a graphic version may be created for callers in color graphics mode. The contents of this file will be paginated, so feel free to make it as long as you need it to be. Line 5: Full Path and Filename of the Main Menu file This line tells the door where to find its main menu. The rules for creating both graphic and non-graphic versions of the main menu are the same as stated above for the opening message, news, logoff, and help displays. A sample main menu file is provided in the ZDoor archive. Line 6: Full Path and Filename of the Files menu file This line tells the door where to find its Files and Archive menu. The rules for creating both graphic and non-graphic versions of this menu are the same as stated above for the opening message, news, logoff, and help displays. A sample files menu is provided in the ZDoor archive. ================================================================== NOTE: The first six lines of the configuration file MUST contain valid DOS file specifications. The files do not need to actually exist, but valid file specifications must be provided nonetheless. ================================================================== Line 7: Full Path and Filename of the PCBoard.Sys file This line tells the door where to find the PCBoard.Sys file that is generated by PCBoard whenever a caller enters a door. Line 8: Full Path and Filename of the PCBoard.Dat file This line tells the door where to find the PCBoard.Dat file that contains the setup information for PCBoard. ZDoor Installation Page 7 ____________________________________________________________________________ Line 9: Full Path and Filename of the DSZ program This line tells the door where to find the DSZ program. Note that the filename extension must be specified as part of the filename e.g. C:\UTIL\DSZ.COM Line 10: DSZ Command Line for Sending a File with ZModem This line is used to specify any DSZ "sender" options that may be required for your system. I would strongly urge that you not fool too much with this line unless you have a good understanding of how the ZModem protocol is implemented in DSZ. Line 11: DSZ Command Line for Receiving a File with ZModem This line is used to specify any DSZ "receiver" options that may be required for your system. As with line 10 (sender options), I would strongly urge that you not fool too much with this line unless you know what you are doing. Do NOT specify the -p option on this line. This option is automatically supplied by ZDoor. If you are using a modem that supports hardware error- correction (eg. MNP) and you have that feature enabled, add "handshake both" to your send and receive command lines at the very beginning. This enables both XON/XOFF and CTS/RTS flow control. eg. Line 10: handshake both pB6144 sz Line 11: handshake both pB6144 rz If you are using a high speed modem and have chosen *NOT* to autobaud (ie. it is locked in at 19.2 or 9.6 kbps at all times), some additional parameters are needed by DSZ to improve flow control and error recovery when sending files. eg. Line 10: handshake both pB6144 z pb1 pw2048 sz Line 11: handshake both pB6144 rz These command lines are consistent with the current settings of the PCBMODEM program for high speed modems running at a fixed baud rate. They should only be used in that configuration as they will decrease Zmodem's efficiency in all other setups. Should you experience ZDoor Installation Page 8 ____________________________________________________________________________ erratic performance using the options shown above, try changing the 'handshake both' parameter to 'handshake cts' as some systems seem to choke on the former. Line 12: DSZ Command Line for Sending a file with YModem This line specifies any YModem Sender options that may be required for your system. Note that no handshake is required for YModem, as the constant ACK/NAK sequences generated by the protocol will serve the same purpose as XON/XOFF or RTS/CTS handshakes. Line 13: DSZ Command Line for Receiving a file with YModem This line specifies any YModem Receiver options that may be required for your system. As with Line 12, no handshake parameters are required here. Line 14: DSZ Command Line for Sending a file with YModem-G This line specifies any YModem-G sender options that may be required by your system. As with the ZModem command lines and depending on your modem type, a handshake parameter and possibly other options may be required here. Please remember that the YModem-G protocol is a "registered version only" DSZ option (ie. if your DSZ has not been registered, you will not be able to offer this protocol to your callers!). If your registration is "in process", you may leave this line (and the following line) blank. This will disable the YModem-G offering to your callers. Once you receive your registered version of DSZ, you can fill in the command line parameters needed by the door. Line 15: DSZ Command Line for Receiving a file with YModem-G This line specifies any YModem-G receiver options that may be required by your system. As with the ZModem command lines and depending on your modem type, a handshake parameter and possibly other options may be required here. One parameter that MUST be specified on this line is '-g', as without this, DSZ will fall back to regular YModem. ZDoor Installation Page 9 ____________________________________________________________________________ As noted in the description for line 14, the YModem-G protocol is available ONLY in registered versions of DSZ. If you are planning to run ZDoor using an unregistered copy (e.g. In the interim between mailing your registration and receiving your DSZ serial number), leave this line blank to disable the protocol. Line 16: Additional Time (in minutes) granted for Uploads The Sysop may specify an additional time credit for uploads. For each file uploaded, the caller will be granted additional time on the system as specified on this line. A value of zero on this line means that no "additional" time will be granted for uploads, but that time spent uploading files will not be charged against the caller. Line 17: Minimum Security Level for Batch Downloads The Sysop may choose to restrict the availability of Batch mode file transfers based on the caller's security level. Callers with a security level that is greater than or equal to the number on this line will be granted access to the Batch Download features of ZDoor and DSZ. Those callers with a lower security level will be allowed single file downloads only. Line 18: Minimum Security Level for Batch Uploads Callers with a security level that is greater than or equal to the number on this line will be granted access to the Batch Upload features of ZDoor and DSZ. Those callers with a lower security level will be allowed single file uploads only. Line 19: Full path and filename of Temporary Archive file This line specifies the name of the archive file created by the 'E)xtract files to Temp Archive' command (in the File & Archive submenu). The filename entered here MUST be different for each node of a multi-node system. Line 20: Minimum Security Level for Archive extraction This line specifies a minimum security level for the 'E)xtract files to Temp Archive' command. Callers with a security level less than this value will be denied the use of the E)xtract command. ZDoor Installation Page 10 ____________________________________________________________________________ Line 21: Full path and filename of file to scan for W)ho command This line specifies the name of a file to be scanned when the W)ho command is selected. The file specified here must follow the format of PCBoard's Download.Txt file. If this line is left empty, ZDoor will use the Download.Txt file specified in your PCBoard.Dat file. Line 22: Minimum security level required to execute W)ho command Specify the minimum security level a caller must have to be able to execute the W)ho command. A value of zero makes the command available to all callers, and a value of 9999 effectively disables the command. Line 23: Full path and filename of MAIL archive file Specify a drive:\path\filename for the archive file to be built by the MAIL command. As with the temporary Archive file, this filename must be different for each node of your system. Line 24: Minimum security level for MAIL command This line specifies the minimum security level a caller must have to execute the MAIL command. Callers with a security less than this value will not be allowed to scan for and download new messages. Line 25: Charge for/Do NOT charge for MAIL downloads Enter a 1 on this line if you wish to charge callers for downloading new mail. Enter a 0 (zero) if mail downloads are free. Line 26: Maximum size allowed for mail archive file You may, if you wish, limit the maximum size of the mail archive to a certain maximum number of Kilobytes (K). If you have a limited amount of free disk space that must be shared between 2 or more nodes, limiting the maximum size will insure that no single node claims all of the free disk space (thus preventing callers on other nodes from downloading new messages). If you are running a single node system or have plenty of disk space, enter a 0 (zero) on this line to allow a mail archive to become as large as the available space on the disk (Note: the MAIL archive will never be allowed to grow so large that it cannot be downloaded within the time available to the caller at the time of its creation). ZDoor Installation Page 11 ____________________________________________________________________________ Environment Variables ===================== The DSZ program uses environment variables to determine certain characteristics of the system on which it is to be run. These variables may be populated in either your AutoExec.Bat file or in the batch file that invokes the ZDoor program. The DOS syntax for setting an environment variable is as follows: SET VARNAME=VALUE Where VARNAME is the name of the variable, and VALUE to be assigned that variable. Consult your DOS manual for further information regarding the SET command. DSZPORT This variable tells DSZ which communications port to use. The value assigned must be an integer in the range 1 through 8 (the maximum number of com ports supported by DSZ). e.g. SET DSZPORT=1 DSZLOG This variable specifies the full path and filename of a file to be used by DSZ to record the results of file transfers. This variable MUST be set if batch transfers are desired. If this variable is not set, or if it does not contain a valid DOS file specification, all batch mode transfers will be disabled (ie. callers will be granted single file transfers only). The file specification provided in this variable MUST be different for each node of a multi-node system. e.g. SET DSZLOG=E:\WORK\NODE1.LOG Batch File Setup ================ A batch file needs to be created to invoke the ZDoor program. This batch file will be renamed to door.bat and executed by PCBoard when the door is selected. The only difference between a "real" batch file and a "door" batch file is the filename extension. While DOS expects the extension to be '.BAT', PCBoard expects no filename extension at all. e.g. "ZDoor.Bat" is no good, but "ZDoor" is fine. Assuming that all ZDoor files are kept in C:\Doors, that C:\Doors is part of your DOS Path, that PCBoard runs on COM1:, and that the ZDoor Installation Page 12 ____________________________________________________________________________ name of the ZDoor configuration file is ZDOOR.CFG, then the following door batch file should suffice: SET DSZPORT=1 SET DSZLOG=C:\DOORS\DSZ.LOG ZDOOR C:\DOORS\ZDOOR.CFG BOARD (If C:\Doors were not part of your DOS Path, the batch file would need to change subdirectories before running the ZDoor program.) If you run a multi-node system, then you will need separate batch files for each node. For instance: Node 1 Node 2 ============================ ============================ SET DSZPORT=1 SET DSZPORT=2 SET DSZLOG=C:\DOORS\DSZ1.LOG SET DSZLOG=C:\DOORS\DSZ2.LOG ZDOOR C:\DOORS\ZDOOR1.CFG ZDOOR C:\DOORS\ZDOOR2.CFG BOARD1 BOARD2 Some sample batch files are provided in the ZDoor archive file. These may be used as templates for building your own batch file(s). ZDoor - Batch file for use on single node system ZDoor1 - Batch file for node 1 of a two node system ZDoor2 - Batch file for node 2 of a two node system NOTE: If your DOORS.DAT is shared between nodes, you would rename both ZDoor1 and ZDoor2 to ZDoor, but place the appropriate one in the "\PCB" subdirectory for each node. Doors.Dat File Entry ==================== The final step for installing ZDoor is to create an entry in your board's DOORS.DAT file (and possibly also in your conference doors.dat file if your conferences do not use the one for the main board area). This file describes all available doors to PCBoard and instructs PCBoard as to the name of the batch file to be invoked when a particular door is selected by the caller. Consult your PCBoard documentation for setup instructions for this file. A sample entry in DOORS.DAT might be: ZMODEM,,43 which means no password is required, and any caller with a security level of 43 or higher may open ZDoor. ZDoor Commands Page 13 ____________________________________________________________________________ Sysop Commands ============== When a remote caller has entered the door from PCBoard, both the caller's keyboard and the sysop's keyboard may be used to enter commands. In this way, a sysop can help a new user by actually showing him how to use the door. This feature is only enabled when the sysop's local display is enabled. Display Toggle The local display can be enabled or disabled by the sysop. When disabled, nothing will be echoed to the screen by the door. The F9 key on the sysop's keyboard toggles the display on/off. On entry, the PCBOARD.SYS file is examined to determine if the display was active prior to the door being invoked. If so, the display is automatically enabled for the door. If the display was disabled in PCBoard, it will remain disabled when the door program is loaded. The state of the display is maintained on return to PCBoard. That is, if the display is on when ZDoor terminates, then it will be on when PCBoard reloads itself and visa-versa. Other Sysop Functions Many functions are available to the sysop via the local console. When the display is enabled, a "PCBoard-like" status line will be displayed. Press the HOME key to change this status line to show the available sysop keys and the functions they provide. The END key may also be used and will change the status line to display the caller's registration information. One function that is not displayed on the local status line when the HOME key is pressed is the ability to dynamically alter the caller's remaining time allowed. The UP ARROW key, when pressed, will add 5 minutes to the time allowed for the current call. Similarly, the DOWN ARROW key will reduce the caller's time allowed for the current call by 5 minutes. Local Testing ZDoor may be run locally to test the configuration and setup. Log onto the board locally, and invoke the ZDoor just as you would if you were calling from remote. The only functions of the door that will not operate properly are the U)pload and D)ownload options (although a simulated file transfer will take place, the door will normally consider the transfers to have failed). The success or failure of these operations in local mode will depend on the contents of the DSZ log file prior to entering the door. ZDoor Commands Page 14 ____________________________________________________________________________ Main Menu Commands ================== ZDoor's menus are not shown to Expert callers. On entry, the caller's USERS file entry is examined to determine the state of the Expert flag and the door's menus are shown/not shown as appropriate. The display of the program's menus may be toggled on/off via the X)pert command (A caller's expert status within ZDoor has no effect on the caller's Expert status in PCBoard). ZDoor's menus, like those for PCBoard, reside on your disk as normal text files (the names of these files are specified in the ZDoor configuration file). Both graphic and non-graphic versions of the menus may be created (the names used for each version follow PCBoard conventions). A sample ZDoor main menu appears below: +--------------------------------------------------------+ | ZDoor Main Menu Options | +--------------------------------------------------------+ | A)bandon Conference NEWS - Display ZDoor News | | D)ownload a File O)perator Page | | F)ile & Archive Menu Q)uit ZDoor to PCBoard | | G)oodbye (Hang Up) R)eset last msg read ptrs | | H)elp with Commands T)ransfer Protocol | | I)nitial Welcome U)pload a File to the BBS | | J)oin a Conference V)iew User Statistics | | L)ocate Files by Name W)ho Uploaded or Down- | | MAIL - Archive mail for d/l loaded a Given File? | | MARK - Tag file(s) for d/l X)pert (Menus ON or OFF) | | M)ode (Graphics) Z)ippy DIR Scan by String | | N)ew Files by Date | +--------------------------------------------------------+ Each option from this menu is described below: A)bandon Conference ------------------- This command revokes access to the currently active conference file directories (ie. returns the caller to the "main board"). D)ownload a file ---------------- This command allows the caller to download a file from the PCBoard file system. If batch mode is enabled, more than one file may be downloaded at a time (up to a maximum of 20). ZDoor Commands Page 15 ____________________________________________________________________________ The filename(s) entered are checked for existence and for FSEC file security constraints before the transfer is begun. In addition, an elapsed time for the transfer is calculated (based on transfer efficiency of 95%) and is compared with the caller's time remaining to be sure that the caller's daily time limit will not be exceeded. Finally the total size of each file is checked against the caller's daily download byte limit to insure that the download will not cause this limit to be exceeded. Before the download begins, a final prompt is issued. This prompt allows the caller to abort the transfer, change the currently selected transfer protocol, logoff when the transfer is completed, or continue with the transfer. If A)bort is selected, the caller is returned to the menu from which the transfer was requested. If T)ransfer Protocol is selected, the caller may select a new protocol for the transfer. If the caller simply presses ENTER, the transfer is begun immediately. If the L)ogoff after transfer option is selected, the transfer will proceed as if the ENTER key had been pressed, but 10 seconds after the completion of the file transfer, he will be logged off the system automatically. During the 10 seconds following the transfer, the caller may enter a ^K or ^X to abort the logoff. Following a successful download, the caller's USERS file entry is updated by incrementing his/her download count. The total size of all downloaded files is then added to the appropriate field in USERS. File transfers are disabled if the PCBoard.Sys file indicates that the caller has connected using 7 data bits and even parity. F)ile & Archive menu -------------------- Entering this command causes a submenu to be displayed. See the description of the File & Archive menu later in this document. G)oodbye (Hang up) ------------------ Choosing this option causes ZDoor to update all relevant USERS file statistics for the caller, write logoff information to the CALLER log, display the Logoff Message file, and drop carrier on the caller. ZDoor Commands Page 16 ____________________________________________________________________________ H)elp ----- Choosing this option causes ZDoor to display a help file to the caller. The name of this file is specified in the ZDoor configuration file. I)nitial Welcome ---------------- This command is analogous to the PCBoard command of the same name with the exception that it is the ZDoor Opening Message file that is displayed rather than the PCBoard Initial Welcome file. J)oin Conference ---------------- After selecting J)oin, the user will be displayed a menu of conferences from which to choose and will be prompted for the number of the conference to join. The caller must be registered in the conference selected or access to that conference will be denied. Once Joined, all conference file directories become available to the caller. L)ocate a file -------------- Selecting this option will prompt the user for a file specification (wildcards are accepted here) to be located and for the directories to be searched. The syntax is exactly the same as the syntax for the Locate command in PCBoard. MAIL ---- This command allows the caller to create an archive file containing unread messages from one or more board message areas. For more information, refer to the chapter on ZDoor Advanced Facilities later in this document. MARK ---- The MARK command is a generic file tagging facility provided throughout the ZDoor program. For information concerning this capability, see the chapter on ZDoor Advanced Facilities later in this document. ZDoor Commands Page 17 ____________________________________________________________________________ M)ode (graphics) ---------------- This command toggles the caller into and out of color graphics mode. Graphics mode will be denied to callers showing a connection using anything other than 8 data bits and no parity. N)ew file scan -------------- This option works in exactly the same way as the PCBoard option of the same name. The user is prompted to enter the date from which to search (or may accept the default date shown), and to enter which directories are to be scanned. The shorthand notations N S U and N S A are also accepted. NEWS ---- This command is analogous to the PCBoard command of the same name with the exception that it is the ZDoor News file that is displayed rather than the PCBoard News file. O)perator Page -------------- This option allows the caller to page the sysop. The page bell will be sounded at the local console only if it has been enabled by the sysop. The sysop may respond to a page with either the spacebar or with the F10 key. Chat mode can be terminated using the ESCape key. Q)uit ZDoor ----------- Selecting this option returns the caller to PCBoard. R)eset Last Msg Read Pointers ----------------------------- This command allows the user to reset the pointers to the last message read in each board message area. For more information on this command, see the chapter on ZDoor Advanced Facilities later in this document. ZDoor Commands Page 18 ____________________________________________________________________________ T)ransfer Protocol ------------------ This command allows the user to select a file transfer protocol for use in subsequent uploads and/or downloads. The caller may select either ZModem or YModem, both of which are batch protocols. Additionally, if the caller has achieved a Reliable Connection using an error correcting modem, YModem-G will be offered as an alternative to ZModem and YModem. Callers with a reliable connection will default to YModem-G on entry to the door. All others default to the ZModem protocol. U)pload a file -------------- * * * * * * * * * * W A R N I N G * * * * * * * * * ZDoor has for some time utilized a feature of DSZ called the "Download Path Specification" when accepting uploads to the bbs. For versions of DSZ dated later than 10/19/88 this feature is reserved for registered versions of the program only! If you are utilizing an unregistered version of DSZ that is dated later than 10/19/88, uploads will not work!!! You have been warned (sorry about that folks). * * * * * * * * * * * * * * * * * * * * * * * * * * * The Upload command allows the caller to send a file to the PCBoard file system. If batch mode is enabled, more than one file may be sent at a time (up to a maximum of 20). The implementation of batch uploads to PCBoard is not without it's quirks, however. Please read the section of this document entitled "Some Notes on Batch Uploads" for the details behind ZDoor's implementation of this facility. The caller is prompted to enter the name of the file he/she wishes to upload. The name entered is checked for duplication elsewhere on the board and for a matching UPSEC file entry. If the file is not a duplicate and if there is no UPSEC security applicable, then a prompt for a file description is displayed. The caller MUST enter a description of at least 10 characters before the description will be accepted. Entering no description at all aborts the upload and returns the caller to the Main Menu. The caller may enter up to two lines of descriptive text for each file to be sent. If the last character of the description is a hyphen (-), a second line will be made available for continuation of the file description. ZDoor Commands Page 19 ____________________________________________________________________________ Note that callers having Sysop Privileges (ie. a security level at or above 100) will be allowed to upload duplicate files. When this occurs, the caller is told that the file is a duplicate and is asked if the existing file should be overwritten. If the caller answers YES to this prompt, the board's copy of the file is erased and the transfer will proceed. Should the answer be NO, that particular file will not be accepted for upload and the board's copy of the file will remain intact. Once all filenames entered have been verified and descriptions entered, a final prompt is issued (this prompt and its options are described earlier in this document under the description for the D)ownload command). Following a successful transfer, the caller's USERS file entry is updated by incrementing the "files uploaded" field and the elapsed time of the transfer is added back into the caller's daily time limit to insure that he/she will not be penalized for time spent uploading files. If an additional upload time credit is specified on line 16 of the configuration file, it too is added to the caller's daily time limit. File descriptions are placed in either the upload DIR or the PRIVATE file depending on the Private Uploads setting in PCBoard.Dat and on the first character of the file description (ie. "/" as 1st char. makes the upload private). Uploads will always be placed initially in the main upload subdirectory for the currently active board area. If the upload is private, it will be moved or, if possible, renamed into the private upload subdirectory as necessary. File transfers are disabled if the PCBoard.Sys file indicates that the caller has connected using 7 data bits and even parity. ZDoor offers your callers the ability to resume an aborted upload. Following an aborted upload, a check is made to determine if more than 0 bytes have been transferred. If so, the caller will be given the opportunity to resume the transfer where it left off. Since only the ZModem protocol allows for this function, the caller will be told to switch to ZModem before beginning the resumed upload. If the caller had originally selected the L)ogoff after transfer option, he will have 10 seconds to abort the logoff at which time the opportunity to resume the aborted transfer will be offered. If the logoff is not aborted, the partial upload will be erased. Note that when resuming an aborted upload, only 1 file may be transferred (ie. you cannot "resume" a batch upload!). ZDoor Commands Page 20 ____________________________________________________________________________ V)iew Statistics ---------------- This option allows the caller to obtain a display of various PCBoard statistics relating to his board activity. Among the statistics displayed are upload and download counts, security level, last time on, last DIR scan date, and more. In addition to historical information, the caller is also shown statistics accumulated during the current call including bytes downloaded and bytes still available for download. W)ho Uploaded/Downloaded ------------------------ This command executes a Zippy-type search of your download.txt file (or a reasonable facsimile thereof) providing your callers with the ability to list the names of all files that they have up/downloaded (by scanning for their own name) or to list the names of people who have up/downloaded a specific file (by scanning for that filename). Since this command might display information which the sysop may deem "proprietary", it may be configured to scan an alternate file (instead of the board's own download.txt file) or it may be disabled altogether. See the description of lines 21 and 22 of the ZDoor configuration file for details. X)pert mode ----------- This option toggles the display of ZDoor menus on/off. Z)ippy file scan ---------------- This option provides the same function and follows the same syntax as the Zippy search command of PCBoard. The caller is prompted for a string to be found and the directories to be searched. A case-insensitive search of the selected directories is then performed. ZDoor allows the incorporation of boolean operators into your search strings to allow queries of the form "find all DIR entries that contain both the words HARD and DISK" or "find all DIR entries that contain either of the words LIST or BROWSE". For more information regarding the use of such operators, refer to the section on Advanced Facilities later in this document. ZDoor Commands Page 21 ____________________________________________________________________________ Files/Archive Submenu Commands ============================== A sample Files/Archive menu appears below: +---------------------------------------+ | ZDoor File and Archive menu options | +--------( File & DIR commands)---------+ | | | <CR> Takes you back to the Main Menu | | # Displays Directory No. # | | D)ownload a File from the System | | H)elp with commands | | L)ist Directory of File Directories | | X)pert Menus On or Off | | MARK - Tag file(s) for download | | | +-------( Archive file commands )-------+ | | | D)ownload the selected Archive | | E)xtract files to a temporary Archive | | R)ead files within selected Archive | | S)elect (new) Archive file to process | | V)erbose listing of Archive contents | | MARK - Tag selected archive for d/l | | | +---------------------------------------+ Note that this menu is logically divided into 2 sections. The top portion deals with PCBoard DIRectories, while the bottom contains options specific to the handling of archive files. To understand the actions behind each of these submenu options, it is important to understand the concept of a "selected" archive file. An archive file is "selected" by entering a valid filename in response to the prompt after issuing any of the commands S, V, E, or R. Once selected, subsequent invocations of V, R, or D commands will operate ONLY on the selected archive file. This selection remains in effect until the caller returns to the main menu or issues a S)elect Archive command. D)ownload a file ---------------- The D)ownload command (when no archive file is selected) functions exactly like the main menu D)ownload command with the exception that following the file transfer, the user is returned to the Files & Archive menu rather than the main menu. ZDoor Commands Page 22 ____________________________________________________________________________ L)ist file DIRectories ---------------------- Selecting this option will display your board's main DIR file (ie. your directory of directories). <#> = view DIRectory # ---------------------- Entering a valid directory number displays that directory. Any number entered that is outside the range of available directories will result in an error message to the caller. Color graphic versions of your DIR files are fully supported by this command. S)elect (new) Archive --------------------- This option allows "selection" of an archive file for processing. The caller will be prompted to enter the name of an archive file (if no extension is entered, .ARC is assumed). If the .ARC file can be found, a verbose listing of it's contents is displayed to the caller. Subsequent V, R, and D commands will apply ONLY to the selected Archive file until the caller either selects another archive file for processing or returns to ZDoor's main menu. V)erbose Archive listing ------------------------ This option produces a standard verbose archive file contents display. The caller will be prompted for the name of an archive file if none is currently selected for processing when the command is issued. R)ead file in selected Archive ------------------------------ This command allows the caller to display the contents of files contained in an archive. The caller is prompted for a file specification (wildcards allowed) for files within the selected archive to be displayed. The archive is then searched for files that match the caller's specification. When a match is found, that file's contents are displayed. Note that files that are obviously binary (based on their filename extension) will not be displayed even if they match the ZDoor Commands Page 23 ____________________________________________________________________________ filespec(s) entered by the caller. These file types include .COM, .EXE, .OBJ, .BIN, .TPU, .WRK, .WR1, .WKS, .DBF, .ARC, .ZOO, .MAC, .PIC, .GIF, .PCX, and .BGI. If no archive file is currently selected when this command is issued, the caller will be prompted for the name of an archive file that can be processed. E)xtract files to Temp Archive ------------------------------ This command allows the caller to extract selected files from one archive file and place those extracted files into a temporary archive file for downloading. The caller may enter up to 5 file specifications (wildcards are allowed) to specify which files will be extracted. The name of the temporary archive created by this command is specified in the ZDoor configuration file. The ZDoor configuration file also specifies a minimum security level for this command. If the caller's security is less than this value, this function will be disallowed for that caller. The temporary archive file created is automatically MARKed for download (for more information on MARKing files, see the Advanced Facilities section of this document). D)ownload selected Archive -------------------------- Issuing the D)ownload command after an archive file has been selected for processing causes the selected file to be downloaded without requiring the caller to type in the file's name. Advanced Facilities Page 24 ____________________________________________________________________________ The MAIL command ================ Overview -------- The MAIL command (available at the main menu prompt) allows a caller to create an archive file that will contain unread messages from one or more board "areas" (ie. the Main Board and/or Conferences). The caller may select specific board areas to scan for new mail or may choose to scan his "default message base areas" (as set via PCBoard's W)rite User Info command). The archive file is created by ZDoor itself (so no separate utilities are required). This allows ZDoor to monitor the size of the mail archive at all times to insure that it does not become so large that it cannot be downloaded within the caller's allotted board time. Should the archive become so large that the time to download it approaches the caller's time limit, or if the size of the archive fills the disk space allotted to it in the ZDoor configuration file, the scan will terminate prematurely and the caller will be informed that the mail scan is incomplete. The archive file created is fully compatible with the popular ARC program (Copyright 1985) from System Enhancement Associates. After the mail has been extracted and compressed into an archive file, it is automatically MARKed for download (for more information, refer to the section on MARKing files in this section of the document). After a successful download of the mail archive, the caller's last message read pointers are updated to reflect the messages that will be read offline by the downloader. Selecting Message Base Areas to Scan -------------------------------------- Upon issuing the MAIL command, the currently selected default message base areas are displayed and the caller is prompted for a list of conferences to scan for mail. The display might look something like this: Your current default conference selection is: (----------1---------2---------3---------) (0123456789012345678901234567890123456789) XXXX XX X Conferences to scan for new mail (Note: Conf. 0 = Main Board) (0 - n) A)bort, L)ist, D)efaults (Enter=Defaults)? Advanced Facilities Page 25 ____________________________________________________________________________ Conference numbers to be scanned may be entered (overriding the default selection), the entire MAIL command may be A)borted, a L)ist of valid conferences can be displayed, or the D)efault conference selection can be accepted. If the default selection is accepted, the scanning and archiving process begins immediately. Updating Default Message Scan Areas ----------------------------------- If the caller overrides the default conference selection by entering specific conference numbers at the MAIL prompt, the new selection of conference message base areas is displayed and several additional options are made available. As an example, suppose the caller entered 0 at the first MAIL prompt (to select only the main board message base for scanning). The following would be displayed: Your new conference selection is: (----------1---------2---------3---------) (0123456789012345678901234567890123456789) X A)bort, R)especify, P)rocess, U)pdate default (Enter=Process)? The options presented here allow the mail scan to be A)borted, the conference selection to be R)especified, the default conference selection (for this and subsequent mail scans) to be U)pdated, or for the specified message bases to be P)rocessed without affecting the caller's default selection for subsequent scans. Resetting Last Message Pointers ------------------------------- Since the MAIL command relies on each caller's "last message read" pointers to determine which messages to include in the archive for download, ZDoor provides the caller with a facility to adjust these pointers. This facility is accessed via the R)eset Msg Pointers command at the main ZDoor menu. The R)eset command issues the following prompt: Reset last message read in which conferences? Note: Conference 0 = Main Board (0 - n) A)ll, D)efault conferences only (Enter=none)? The caller may reset his pointers for selected conference message bases, for A)ll of them, or for his D)efault conferences only. For each conference message base selected, ZDoor displays the name and number of the board area being processed, the lowest Advanced Facilities Page 26 ____________________________________________________________________________ numbered message in that area, the highest numbered message, the last message read (as recorded in the USER record for that caller), and the total number of active messages in that area's message base. Entering a valid message number (ie. one that is greater than or equal to the low message number and less than or equal to the high message number) causes the last message read pointer for that message base to be set to the that number. Entering Q)uit at any point in the process will abort the R)eset command without abandoning any pointer changes made thus far. The MARK Facility ================= Overview -------- ZDoor's MARK facility provides the caller with a method for tagging up to 20 files for eventual download in a single batch. A list of MARKed files is maintained internally by the program for the duration of the session (ie. until the caller hangs up or returns to PCBoard). Commands are available for adding filenames to the list, for removing filenames from the list, for viewing the list, and for downloading all files in the list. The MARK command is available from either of ZDoor's menus and from most 'More?' prompts (while viewing/scanning DIR files, viewing archive contents, reading archived text files, etc.). MARK Options ------------ Issuing the MARK command with no stacked options causes the following prompt to be displayed: Enter filename(s) (mark/unmark) or C)lear, D)ownload, L)ist? ===> The prompt shown above displays all of the options available for the MARK facility. Files may be added to or removed from the list of MARKed files, specific list entries may be C)leared, a display may be requested L)isting all files that are currently MARKed, or the list of MARKed files may be D)ownloaded as a single batch. MARKing Files ------------- To add a file to the list maintained by the MARK command, simply enter its name at the MARK prompt shown above. After verifying Advanced Facilities Page 27 ____________________________________________________________________________ the existence of the file by searching the board's file system and checking for possible FSEC security restraints, the file's name will be added to the list. As with most other ZDoor commands, options to the MARK command may be stacked along with the command itself so that the entry MARK filename.ext accomplishes the same function as entering MARK, waiting for the command's option prompt, and then entering 'filename.ext'. If a caller is currently at the ZDoor Files/Archive submenu and has an archive file selected, entering MARK with no stacked options causes the currently selected archive file to be MARKed/unMARKed. Listing MARKed File Names ------------------------- Entering L at the MARK option prompt displays a list of the currently MARKed files (typing 'MARK L' at the ZDoor Command prompt accomplishes the same result). Each MARKed file is assigned a number from 1 to 20. These numbers can be used to unMARK any of the listed files (as detailed below). UnMARKing Files --------------- A file can be unMARKed in either of two ways. Entering the name of a previously MARKed file at the MARK options prompt will cause that name to be removed from the list. Alternatively, the C)lear option can be used to remove a file from the list. The C)lear option prompts the caller to enter the number of the entry in the list to be cleared. List entry numbers are displayed via the 'MARK L' command. Files are automatically unMARKed after they have been successfully downloaded. Downloading MARKed Files ------------------------ There are three ways to download all MARKed files. The first method is to enter D at the MARK prompt (or just stack the command as 'MARK D'). The second alternative is to enter 'D *' at the ZDoor Command prompt (the download routine in ZDoor will substitute the names of all MARKed files in place of the asterisk character). Advanced Facilities Page 28 ____________________________________________________________________________ Finally, the caller can do nothing at all! Anytime a download is requested or the caller attempts to exit the door via the Q)uit or G)oodbye commands, ZDoor looks to see if there are any names in the MARK list. If there are, a reminder is displayed and the caller is prompted as to whether the list should be downloaded right then and there. Zippy Search String Enhancements ================================ ZDoor allows the entry of multiple keywords in its searches (both the Zippy DIR and the Download.Txt searches). Multiple keywords must be separated by one of two boolean operators: the logical AND operator or the logical OR operator. The logical AND operator is represented by the + character and the logical OR operator is represented by |. Since this concept is easier to explain by example than it is through words alone, lets immediately dive into some examples of what we're talking about. Assume the caller were interested in board files dealing with hard disks. A Zippy search on the term DISK would certainly do the trick, but would also clutter up the display by matching entries that deal with floppy disks as well as hard disks. The solution would be to enter the search string "HARD + DISK" to restrict the search to only those entries containing both of the terms HARD 'and' DISK. Similarly, if the caller were interested in files dealing with either the Basic or Pascal programming languages, he could perform two Zippy scans, one on the term BASIC and one on the term PASCAL, or he could perform a single search on the string "BASIC | PASCAL" to match any entry containing either the term BASIC 'or' the term PASCAL. Continuing with the above examples, suppose our mythical caller were the same person in both instances ... a single search on the string "BASIC | PASCAL | HARD + DISK" would net the same results in a single Zippy scan as issuing both of the previous example strings. There are only a couple of rules to be followed in utilizing the enhanced search strings described above. The first is that the logical AND operator takes precedence over the logical OR operator (ie. + operators are evaluated before | operators). The second rule deals with spaces that may be embedded in a search string. As before, it is easier to explain this rule by example than it is with words. Advanced Facilities Page 29 ____________________________________________________________________________ Generally, spaces embedded within a search string are considered significant. Thus, searching on the string 'This String' will match entries containing the term 'This' followed by a space followed by the term 'String'. The exception to this is when the search string is "stacked" on the ZDoor command line. This is not allowed because spaces are considered valid command line delimiters (much the same as semi-colons are valid command line delimiters). To search on a string that contains embedded spaces, the caller must issue the search command (e.g. 'Z') and allow ZDoor to prompt for the string to be located. Even when ZDoor is allowed to prompt for the search string, not all spaces are significant. Consider the following string entered in response to a Zippy search prompt: Enter text to scan for (Enter)=none, (+)=AND, (|)=OR |--------------------------------------------------| ? This string | That string + Another string /|\ /|\ /|\ | | | +- These 3 spaces are significant -+ All others are stripped away before the search begins If the issue of embedded spaces seems complicated, be assured that a little experimentation will clear up the matter very quickly. Some Notes on Batch Uploads Page 30 ____________________________________________________________________________ When the U)pload command is issued in ZDoor, the program requests that the caller enter the names of and descriptions for each file to be transferred. The door does not, however, restrict the caller from uploading only those files specified. This makes it possible for a file uploaded in ZDoor to reside on the system without a proper file description and without having been checked for duplication elsewhere on the board. In this instance, ZDoor will process the file after the upload by scanning the system for duplication and by prompting the caller for a proper file description. Should ZDoor determine that the unannounced upload duplicates a current board file, or if the caller refuses to provide a file description, ZDoor will rename the file and post it in the sysop's PRIVATE upload DIR and subdirectory. The renamed file will have the form ZDRnnnnn.EXT where nnnnn represents some sequence of digits that insure a unique filename (eg. ZDR00015) and where the filename extension is retained from the original filename. After renaming the file, a message is placed in both the board's caller log and the private DIR containing the original name of the upload and the name of the caller who uploaded the file (thus allowing the sysop to manually determine if the file should be posted). Acknowledgements Page 31 ____________________________________________________________________________ At this point in the documentation, I would normally list the names of all of the people who helped in one way or another with the development of the program. Unfortunately, a list such as that would probably go on for several pages. Suffice it to say that I have received assistance, advice, and support from many people. I would like to thank all those involved in the development and testing of ZDoor and all who have contributed ideas, suggestions, and even money to help make ZDoor the premier ZModem file transfer door available for PCBoard. Without the assistance of all of these dedicated people, I would have given up long ago. Special credit must, however, be given to a number of individuals who have made major contributions to the development of this program. My personal thanks go out to Paul Kopit, Dr. S. David Klein, Robert Blacher, Richard Driggers and Chuck Ammann. Thanks also to Phil Burns for publishing a wonderfully useful set of communications routines, to Chuck Forsberg (of course) for creating the DSZ program, and to Fred Clark for creating the environment under which ZDoor executes. Sysops please note: For those of you that install this door along with Chuck Forsberg's DSZ program, I urge you to comply with Chuck's request that you make his programs available to your callers for downloading. It ain't much to ask, and the addition of Zmodem Batch to your board's available file transfer protocols is well worth the disk space required. I would also ask that you urge your callers to support the continued development of DSZ by registering their copy with Omen Technologies. At $20.00, it's one of the best PC Software bargains around. See DSZ's documentation for information on use and registration of DSZ by Sysops of "qualified" bulletin boards. Feedback Page 32 ____________________________________________________________________________ Please report any problems or difficulties in the use of this program to me. I will attempt to resolve any and all trouble reports. I can be reached on any of the fine bulletin boards listed below: Software Society Sysop: Paul Kopit (201) 729-7410 PC-Rockland Sysop: Charlie Innusa Computer Connections (914) 353-2176 Sysop: Robert Blacher (202) 547-2008 Tamiami Sysop: Gerhard Barth Northern Lights (813) 793-2392 Sysop: Jack Kilday (207) 766-2467 Software Society South Sysop: Dave Klein Chuck's Attempt (201) 214-8896 Sysop: Chuck Ammann (201) 729-2602 rpb